home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lInfoIndxNode.3 < prev    next >
Text File  |  1993-08-08  |  837b  |  37 lines
  1. '.so tmac.clman
  2. .TH "lInfoIndxNode"
  3. .IX lInfoIndxNode
  4. .SH NAME
  5. lInfoIndxNode - Get information about node by index.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lInfoIndxNode" "(id, index, size, flag)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    id    identifier of linked list
  13. .RP
  14. In    int    index    index of node which must be inspected
  15. .RP
  16. Out    int    *size    size of data of node
  17. .RP
  18. Out    int    *flag    user information flag
  19. .DT
  20. .SH DESCRIPTION
  21. \fBlInfoIndxNode\fP returns some information about an indexed node.
  22. The size of the data of the node (\fIsize\fP) and the user information
  23. flag (\fIflag\fP). Of which node the information must be given can be
  24. specified by \fIindex\fP (\(>= 1).
  25. .SH RETURN CODES
  26. .nf
  27. Return on success :
  28.     lSUCCESS
  29. Return on error :
  30.     lUNKNOWN_ID, lEMPTY_LIST, lWRONG_INDEX
  31. .fi
  32. .SH AUTHOR
  33. .nf
  34. Anita Eijs (TNO - Bouw - BouwInformatica)
  35. Shane Brath (University of Wisconsin)
  36. .fi
  37.